Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 30, 2024

OnSearch callback support async

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4967

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add async support to the OnSearch callback in the Search component and introduce a generic type parameter for enhanced type safety. Update related unit tests to reflect these changes.

New Features:

  • Add support for async OnSearch callback in the Search component.

Enhancements:

  • Introduce a generic type parameter TValue to the Search component for better type safety and flexibility.
  • Add OnGetDisplayText parameter to customize display text for search results.

Tests:

  • Update unit tests to accommodate changes in the Search component, including async OnSearch and new display text logic.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 30, 2024

Reviewer's Guide by Sourcery

The pull request refactors the Search component to support a generic type parameter and an async OnSearch callback, allowing for more flexible and dynamic search operations. It also updates related unit tests and sample components to align with these changes. Additionally, the AutoFill component's Template parameter is deprecated in favor of ItemTemplate, and the OnSearch method in the Coms component is adjusted to handle nullable strings.

Sequence diagram for Search component interaction

sequenceDiagram
    participant U as User
    participant S as Search~TValue~
    participant C as OnSearch Callback

    U->>S: Enter search text
    S->>S: Update _displayText
    U->>S: Click search button
    S->>S: Set loading icon
    S->>C: OnSearch(_displayText)
    C-->>S: Return IEnumerable~TValue~
    S->>S: Update FilterItems
    S->>S: Reset button icon
    alt IsAutoClearAfterSearch is true
        S->>S: Clear _displayText
    end
    S->>S: Show filtered items
Loading

File-Level Changes

Change Details Files
Refactor Search component to support generic type TValue and async OnSearch callback.
  • Changed Search component to be generic with type parameter TValue.
  • Updated OnSearch callback to support async operations and return IEnumerable.
  • Added OnGetDisplayText parameter to customize display text for search results.
  • Modified internal logic to use _displayText instead of Value for search operations.
src/BootstrapBlazor/Components/Search/Search.razor.cs
src/BootstrapBlazor/Components/Search/Search.razor
Update unit tests to accommodate changes in Search component.
  • Updated test cases to use generic Search component with specific types.
  • Modified test logic to handle async OnSearch callback and new display text logic.
test/UnitTest/Components/SearchTest.cs
Deprecate Template parameter in AutoFill component in favor of ItemTemplate.
  • Added obsolete attribute to Template parameter and redirected it to ItemTemplate.
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs
Update sample components to reflect changes in Search and AutoFill components.
  • Replaced Template with ItemTemplate in AutoFill component samples.
  • Added new demo block for Search component with ItemTemplate usage.
src/BootstrapBlazor.Server/Components/Samples/AutoFills.razor
src/BootstrapBlazor.Server/Components/Samples/Searches.razor
src/BootstrapBlazor.Server/Components/Samples/InputGroups.razor
Adjust OnSearch method in Coms component to return nullable strings.
  • Changed OnSearch method to return IEnumerable<string?> instead of IEnumerable.
  • Updated logic to handle nullable strings.
src/BootstrapBlazor.Server/Components/Pages/Coms.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4967 Make the component's data provider an async function for flexible data provision
#4967 Make the dropdown items' UI customizable

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Dec 30, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 30, 2024
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Dec 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7c5b136) to head (af0222c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5000   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          630       630           
  Lines        27907     27917   +10     
  Branches      3991      3993    +2     
=========================================
+ Hits         27907     27917   +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 17d5dba into main Dec 30, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-search branch December 30, 2024 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Search): OnSearch callback support async

2 participants